//
// Copyright (C) 2015 Irene Ruengeler
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//

package inet.applications.packetdrill;

import inet.applications.contract.IApp;

//
// This is a port of Google's Packetdrill testing tool into the INET Framework.
//
// Google released the script-based Packetdrill tool in 2013. It allows one
// to test transport protocols like UDP and TCP on Linux and BSD-based
// operating systems. Scripts define test cases that inject packets to the
// protocol implementation under test, perform operations using the API
// controlling the transport protocol, and verify the sending of packets, all
// at specified times. The ported version provides a simple and powerful
// method of testing transport protocols implemented in INET.
//
simple PacketDrillApp like IApp
{
    parameters:
        string scriptFile;
        double startTime @unit(s) = default(0s);
        int localPort; // port number of the initiator
        int remotePort;
        string localAddress;
        string remoteAddress;
        string interfaceTableModule;
        string interface;   // tun interface name
        int inboundStreams = default(20);
        int outboundStreams = default(20);
        int streamReset = default(0);
        string crcMode @enum("declared", "computed") = default("declared");
        double latency @unit(s) = default(0s);
        @display("i=block/app");
    gates:
        input socketIn;
        output socketOut;
}

